home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / espnotify.z / espnotify
Encoding:
Text File  |  2002-10-03  |  16.5 KB  |  397 lines
  1.  
  2.  
  3.  
  4. eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))                                                      eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      espnotify - a generic command line notification utility for SGI Embedded
  10.      Support Partner
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ////uuuussssrrrr////bbbbiiiinnnn////eeeessssppppnnnnoooottttiiiiffffyyyy [[[[----nnnn priority ----dddd]  -E <_e-_m_a_i_l _a_d_d_r_e_s_s_e_s> [----FFFF <_S_e_n_d_e_r _a_d_d_r_e_s_s>]
  14.                         { ----ffff <_f_i_l_e_n_a_m_e> | ----mmmm <_m_e_s_s_a_g_e> }
  15.                         [----oooo <_p_r_o_c_e_s_s_i_n_g _o_p_t_i_o_n_s>] [----ssss <_s_u_b_j_e_c_t>]
  16.  
  17.      ////uuuussssrrrr////bbbbiiiinnnn////eeeessssppppnnnnoooottttiiiiffffyyyy [[[[----nnnn priority ----dddd]  -c <_m_e_s_s_a_g_e> [----aaaa] [----DDDD <_D_i_s_p_l_a_y>] [----gggg <_g_e_o_m_e_t_r_y>]
  18.                         [----iiii <_i_c_o_n _i_m_a_g_e>] [----tttt <_t_i_t_l_e>]
  19.  
  20.      ////uuuussssrrrr////bbbbiiiinnnn////eeeessssppppnnnnoooottttiiiiffffyyyy [[[[----nnnn priority ----dddd] -C <_m_e_s_s_a_g_e> ----pppp <_p_a_g_e_r_s> [----SSSS <_p_a_g_i_n_g _s_e_r_v_i_c_e>]
  21.                         [----QQQQ <_q_p_a_g_e _s_e_r_v_e_r>]
  22.  
  23.      ////uuuussssrrrr////bbbbiiiinnnn////eeeessssppppnnnnoooottttiiiiffffyyyy [[[[----nnnn priority ----dddd] -A <_m_e_s_s_a_g_e>
  24.  
  25. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.      _e_s_p_n_o_t_i_f_y is a generic command line utility that is packaged with SGI
  27.      Embedded Support Partner (see eeeesssspppp(5) for more details).  It is used to
  28.      perform various types of notifications.
  29.  
  30.      _e_s_p_n_o_t_i_f_y can post a given message to e-mail addresses, can display a
  31.      message on local/remote X display, can post a message to a paging service
  32.      to be delivered to a pager or can display the message on the system
  33.      console.
  34.  
  35.      _e_s_p_n_o_t_i_f_y supports various command line options for various types of
  36.      notifications.  These options are discussed in detail later in this man
  37.      page.  More than one type of notification can be specified at a time.
  38.      There are some general options that are applicable to all types of
  39.      notifications.  These general options are :
  40.  
  41.      ----dddd   This causes espnotify to display debug information.
  42.  
  43.      ----nnnn _r_a_n_g_e _f_r_o_m _1 _t_o _7
  44.           Provide a numeric priority for the message (defaults to 7).  The
  45.           priorities are decoded as follows :
  46.                     1 and 2   Critical Message
  47.                     3         Error Message
  48.                     4         Warning Message
  49.                     5 to 7    Informational Message
  50.  
  51.  
  52. EEEE----MMMMAAAAIIIILLLL NNNNOOOOTTTTIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  53.      The first synopsis is for posting a message to specified e-mail
  54.      addresses.  _e_s_p_n_o_t_i_f_y invokes /usr/lib/sendmail to deliver message to the
  55.      e-mail addresses specified with -_E option. -_F option can be used to
  56.      specify the e-mail sender address.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))                                                      eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))
  71.  
  72.  
  73.  
  74.      The options for e-mail notification include:
  75.  
  76.      ----EEEE _e-_m_a_i_l _a_d_d_r_e_s_s_e_s
  77.           Comma separated list of e-mail addresses for use in e-mail
  78.           notifications.  This option must be specified for e-mail
  79.           notification to work.
  80.  
  81.      ----FFFF _S_e_n_d_e_r _E_m_a_i_l _a_d_d_r_e_s_s
  82.           This is to override  ESP Customer Profile user-defined _S_e_n_d_e_r _E_m_a_i_l
  83.           _A_d_d_r_e_s_s value which is actually passed to espnotify as an
  84.           environment variable EEEESSSSPPPP____MMMMAAAAIIIILLLL____FFFFRRRROOOOMMMM.  If none of them are defined(or
  85.           empty), the sender is set to the current executing username.
  86.  
  87.      ----ffff _f_i_l_e_n_a_m_e
  88.           This specifies a text file content of which is used for e-mail
  89.           notification.  A binary file may be sent if the ----oooo option is used.
  90.  
  91.      ----mmmm _m_e_s_s_a_g_e
  92.           This option is used when the content for an email notification is to
  93.           be a string.  All strings must be enclosed in double quotes.  Please
  94.           note that ----mmmm and ----ffff options are mutually exclusive. The message may
  95.           contain special MMMMeeeessssssssaaaaggggeeee FFFFoooorrrrmmmmaaaatttt CCCCooooddddeeee.
  96.  
  97.      ----oooo _p_r_o_c_e_s_s_i_n_g _o_p_t_i_o_n_s
  98.           Processing options for the message.  Supported options are _C_O_M_P
  99.           (compress and uuencode the message) and _E_N_C_O (uuencode the message).
  100.           Processing options are valid only with ----ffff option.
  101.  
  102.      ----ssss _s_u_b_j_e_c_t
  103.           Subject for the message.  In case no subject is given, a default
  104.           subject is provided by _e_s_p_n_o_t_i_f_y. The format of the default subject
  105.           is as follows :
  106.  
  107.               [HOSTNAME]: <text>
  108.  
  109.               where,
  110.               HOSTNAME is the name of the host
  111.               <text> can be "Critical System Error" or "System Error" or
  112.                      "System Warning" or "System Information" depending
  113.                      on priority.
  114.  
  115.           If both subject and priority are specified, the subject specified
  116.           with -s overrides the default subject.  If neither a subject or
  117.           priority is specified, the subject will default to "[HOSTNAME]:
  118.           System Information".
  119.  
  120. GGGGRRRRAAAAPPPPHHHHIIIICCCCAAAALLLL NNNNOOOOTTTTIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  121.      The second synopsis is for displaying a message (graphical notification)
  122.      to a local/remote X display.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))                                                      eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))
  137.  
  138.  
  139.  
  140.      The options for graphical notification include:
  141.  
  142.      ----aaaa   This option specifies that audio should be used along with graphical
  143.           notification.  Audio notification cannot be run without graphical
  144.           notification.  Audio is played via the /usr/sbin/ssplay command on
  145.           which host it is executed.  It is not possible to play audio on a
  146.           remote host. NNNNOOOOTTTTEEEE:::: this is not supported on Linux.
  147.  
  148.      ----cccc _m_e_s_s_a_g_e
  149.           A text string for use as GUI notification content.  Text must be
  150.           contained within double quotes if spaces are needed in the string.
  151.           This option must be specified to perform a graphical notification.
  152.           The message may contain special MMMMeeeessssssssaaaaggggeeee FFFFoooorrrrmmmmaaaatttt CCCCooooddddeeee.
  153.  
  154.      ----DDDD _D_i_s_p_l_a_y
  155.           Specifies an alternate display host on which to display a graphical
  156.           notification.  The default is to display on the host specified in
  157.           the $DISPLAY environment variable.
  158.  
  159.      ----gggg _g_e_o_m_e_t_r_y
  160.           X compatible geometry string in the form WIDTHxHEIGHT+XOFF+YOFF
  161.           where WIDTH, HEIGHT, XOFF, and YOFF are numbers) for specifying a
  162.           preferred size and location for this application's main window.
  163.  
  164.      ----iiii _i_c_o_n _i_m_a_g_e
  165.           This option specifies the icon to display within graphical
  166.           notifications.
  167.  
  168.           There are four options:
  169.  
  170.                _CCCC_rrrr_iiii_tttt_iiii_cccc_aaaa_llll
  171.                _EEEE_rrrr_rrrr_oooo_rrrr
  172.                _WWWW_aaaa_rrrr_nnnn_iiii_nnnn_gggg
  173.                _IIII_nnnn_ffff_oooo
  174.  
  175.           If a priority is set with the -n option, the icon is set
  176.           accordingly.  If neither priority or icon_image is specified, the
  177.           "Info" icon will be defaulted to. NNNNOOOOTTTTEEEE:::: On Linux, this option is
  178.           deprecated. However, option -_n will be used instead and a color of
  179.           Red will be assigned for values of n up to 3, Yellow for 4, nothing
  180.           otherwise.
  181.  
  182.      CCCCaaaavvvveeeeaaaattttssss::::
  183.           On Linux xmessage is used. On Linux, xmessage is used instead.
  184.  
  185.      ----tttt _t_i_t_l_e
  186.           This specifies the title of the graphical notification.  If a
  187.           numeric notification priority is set with -n, title defaults to:
  188.  
  189.                Priority 1 - "Critical System Error"
  190.                Priority 2 - "System Error"
  191.                Priority 3 - "System Warning"
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))                                                      eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))
  203.  
  204.  
  205.  
  206.                Priority 4 - "System Information"
  207.  
  208.           If neither a title nor priority are specified the title will default
  209.           to:  "System information"   If a priority is specified, a custom
  210.           title can still be specified.
  211.  
  212. PPPPAAAAGGGGEEEERRRR NNNNOOOOTTTTIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  213.      The third synopsis is for sending a message to a specified pager.
  214.      _e_s_p_n_o_t_i_f_y uses _q_p_a_g_e (see _Q_u_i_c_k_P_a_g_e(1m) for more details) to deliver the
  215.      message. The QuickPage daemon must be running on the machine that
  216.      delivers the page.  This daemon is started during system startup if
  217.      chkconfig variable, quickpage is turned on. (NNNNOOOOTTTTEEEE:::: this may not be true
  218.      for Linux.)
  219.  
  220.      NNNNOOOOTTTTEEEE:::: The Linux version of ESP do not install qpage but ESP will honor it
  221.      if it is installed in /usr/local/bin directory.
  222.  
  223.      The configuration of the daemon can be done via SGI Embedded Support
  224.      Partner User Interface.  Please refer to the SGI Embedded Support Partner
  225.      User's Guide for more details.
  226.  
  227.      The options for paging notification include:
  228.  
  229.      ----CCCC _m_e_s_s_a_g_e
  230.           Specifies a text string for use as alphanumeric page content.  Text
  231.           must be contained within double quotes if spaces are needed in the
  232.           string. This option must be specified for paging notification to
  233.           work. The message may contain special MMMMeeeessssssssaaaaggggeeee FFFFoooorrrrmmmmaaaatttt CCCCooooddddeeee
  234.  
  235.  
  236.      ----pppp _p_a_g_e_r_s
  237.           Comma separated list of pager or pager-ids that are to receive a
  238.           notification.  One or more  of each can be specified on the command
  239.           line.  Pager specifications are stored in /etc/qpage.cf file on the
  240.           server that is delivering the page.  The pagers can be set from the
  241.           SGI Embedded Support Partner User Interface.
  242.  
  243.  
  244.      ----SSSS _p_a_g_i_n_g _s_e_r_v_i_c_e
  245.           This options allows the specification of an alternate paging
  246.           service.  Service specifications are stored in /etc/qpage.cf file on
  247.           the server that is delivering the page.  These services can be set
  248.           from the SGI Embedded Support Partner User Interface.  If no service
  249.           is specified then the service with name set as 'default' is used to
  250.           deliver the page.
  251.  
  252.  
  253.      ----QQQQ _q_p_a_g_e _s_e_r_v_e_r
  254.           This option allows the specification of an alternate server on which
  255.           the QuickPage daemon is running.  If this option is not specified a
  256.           connection to the local Qpage daemon will be tried.
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))                                                      eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))
  269.  
  270.  
  271.  
  272. CCCCOOOONNNNSSSSOOOOLLLLEEEE NNNNOOOOTTTTIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  273.      The fourth synopsis is to display message on the terminal/system console.
  274.      The message specified with ----AAAA is displayed on the standard output of the
  275.      terminal if open.  Otherwise, the message is displayed on the system
  276.      console. The message may contain special MMMMeeeessssssssaaaaggggeeee FFFFoooorrrrmmmmaaaatttt CCCCooooddddeeee.
  277.  
  278.  
  279. MMMMEEEESSSSSSSSAAAAGGGGEEEE FFFFOOOORRRRMMMMAAAATTTT CCCCOOOODDDDEEEESSSS
  280.      Any _m_e_s_s_a_g_e can contain _f_o_r_m_a_t _c_o_d_e_s that has  special meaning when EEEESSSSPPPP
  281.      execute the action.  Just specify  event information to be included in
  282.      the notification message.  You can include any of the following format
  283.      codes:
  284.  
  285.           %H = host name where the event originated (default)
  286.           %D = event data (this is the data received with the event) (default)
  287.           %z = Event time stamp (in mm/dd/yyyy hh:mm:ss format) (default)
  288.           %c = event class description
  289.           %C = event class ID
  290.           %e = event type description
  291.           %T = event type ID
  292.           %O = event ID (as registered by ESP)
  293.           %F = forwarder hostname (in case of SGM)
  294.           %I = system ID
  295.  
  296.           NNNNOOOOTTTTEEEE: Message code are for general usage , ie. for use with other ESP actions
  297.                          scripts.
  298.  
  299.  
  300. EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  301.      Send a prioritized GUI notification.
  302.  
  303.      % espnotify -n 2 -c "Widget 25 failure"
  304.  
  305.      Send a prioritized e-mail notification with string content along with a
  306.      page.  In this example we are using a "pager" definiton defined in
  307.      /etc/qpage.cf as the argument for the -p parameter.
  308.  
  309.      % espnotify -n 2 -E john@xyz.com -m "System disk is nearing capacity" -p
  310.      johndoe -C "System disk is nearing capacity"
  311.  
  312.      Send a page to "johndoe".  Use an alternate Qpage server along with an
  313.      alternate paging service.  "johndoe" along with the alternate paging
  314.      service name must exist in /etc/qpage.cf configuration file on the
  315.      alternate QuickPage Server.
  316.  
  317.      % espnotify -C "System temperature too high" -Q pager.server.com -S
  318.      airtouch -p johndoe
  319.  
  320.      % espnotify -E esp_users@xyz.com -m "On %H at %z : %D(%T)"
  321.  
  322.      Send a non-prioritized e-mail message notification with string content
  323.      made of the host (%H) where the event originated. Date(%z), event
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))                                                      eeeessssppppnnnnoooottttiiiiffffyyyy((((1111))))
  335.  
  336.  
  337.  
  338.      description(%D) and ESP event number(%T) are also supplied.
  339.  
  340. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  341.      Mail(1), QuickPage(1m), esp(5).
  342.  
  343. RRRREEEEFFFFEEEERRRREEEENNNNCCCCEEEESSSS
  344.      SGI Embedded Support Partner Documentation.
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                                                         PPPPaaaaggggeeee 6666
  394.  
  395.  
  396.  
  397.